♻️ Refactor: migrate more aiohttp app keys to type-safe web.AppKey #8424

pcrespov · 2025-09-25T16:10:50Z

What do these changes do?

Follows up on PR #8405
This continues the migration of aiohttp app keys from plain strings to type-safe web.AppKey.

SEE https://docs.aiohttp.org/en/stable/web_reference.html#aiohttp.web.AppKey

Changes

Before

from typing import Final

APP_MY_KEY: Final[str] = f"{__name__}.APP_MY_KEY"
app[APP_MY_KEY] = value
data = request.app[APP_MY_KEY]

After

from typing import Final
from aiohttp import web

CONSTNAME_APPKEY: Final = web.AppKey("CONSTNAME", SomeSpecificType)
app[CONSTNAME_APPKEY] = value
data = request.app[CONSTNAME_APPKEY]  # type-safe
# no need to cast anymore — mypy infers the correct type

NOTE: this can be done using refactor-aiohttp-appkey.prompt.md

Additions

Introduced application_keys.py (or $(domain)/_application_keys.py)
Added refactor-aiohttp-appkey.prompt.md to streamline future refactors

Related issue/s

How to test

in place

Dev-ops

None

… instances in various modules

codecov · 2025-09-25T16:12:51Z

Codecov Report

❌ Patch coverage is 94.76923% with 17 lines in your changes missing coverage. Please review.
✅ Project coverage is 87.85%. Comparing base (1dbb64b) to head (2d612cb).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #8424      +/-   ##
==========================================
- Coverage   89.01%   87.85%   -1.17%     
==========================================
  Files        1753     1957     +204     
  Lines       68638    76126    +7488     
  Branches      837     1342     +505     
==========================================
+ Hits        61098    66877    +5779     
- Misses       7331     8845    +1514     
- Partials      209      404     +195

Flag	Coverage Δ
integrationtests	`64.10% <72.93%> (+0.73%)`	⬆️
unittests	`86.51% <94.15%> (-1.53%)`	⬇️

Components	Coverage Δ
pkg_aws_library	`93.59% <ø> (ø)`
pkg_celery_library	`83.41% <ø> (ø)`
pkg_dask_task_models_library	`79.33% <ø> (ø)`
pkg_models_library	`93.08% <ø> (ø)`
pkg_notifications_library	`85.20% <ø> (ø)`
pkg_postgres_database	`87.95% <ø> (ø)`
pkg_service_integration	`70.19% <ø> (ø)`
pkg_service_library	`72.55% <59.09%> (∅)`
pkg_settings_library	`90.19% <ø> (ø)`
pkg_simcore_sdk	`84.93% <ø> (+19.65%)`	⬆️
agent	`93.53% <ø> (ø)`
api_server	`91.94% <ø> (ø)`
autoscaling	`95.74% <ø> (ø)`
catalog	`92.36% <ø> (ø)`
clusters_keeper	`99.13% <ø> (ø)`
dask_sidecar	`91.82% <ø> (-0.56%)`	⬇️
datcore_adapter	`97.94% <ø> (ø)`
director	`75.81% <ø> (ø)`
director_v2	`90.84% <ø> (-0.10%)`	⬇️
dynamic_scheduler	`96.30% <ø> (ø)`
dynamic_sidecar	`90.43% <ø> (ø)`
efs_guardian	`89.62% <ø> (ø)`
invitations	`91.44% <ø> (ø)`
payments	`92.62% <ø> (ø)`
resource_usage_tracker	`92.18% <ø> (+0.05%)`	⬆️
storage	`86.65% <ø> (ø)`
webclient	`∅ <ø> (∅)`
webserver	`87.86% <97.35%> (+0.08%)`	⬆️

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1dbb64b...2d612cb. Read the comment docs.

🚀 New features to boost your workflow:

📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

mergify · 2025-09-25T16:37:24Z

🧪 CI Insights

Here's what we observed from your CI run for 2d612cb.

✅ Passed Jobs With Interesting Signals

Pipeline	Job	Signal	Retries	🔍 CI Insights	📄 Logs
`CI`	`integration-tests`	Base branch is broken, but the job passed. Looks like this might be a real fix 💪	`0`	View	View
	`system-tests`	Base branch is broken, but the job passed. Looks like this might be a real fix 💪	`0`	View	View
	`unit-tests`	Base branch is broken, but retries were needed. Could be early signs of flakiness 👀	`1`	View	View

…plication_keys - Updated imports across multiple modules to source APP_SETTINGS_KEY from application_keys instead of constants. - This change improves the organization of application keys and reduces potential circular dependencies.

…name for consistency

Copilot

Pull Request Overview

This pull request continues the migration of aiohttp app keys from plain string constants to type-safe web.AppKey objects, building on the work started in PR #8405. This refactoring improves type safety and eliminates the need for manual type casting when accessing application state.

Key changes include:

Converting string-based app key constants to web.AppKey objects with proper typing
Updating all usage patterns throughout the codebase to use the new type-safe keys
Creating centralized application_keys.py files to organize these definitions

Reviewed Changes

Copilot reviewed 112 out of 113 changed files in this pull request and generated 3 comments.

File	Description
services/web/server/src/simcore_service_webserver/application_keys.py	New centralized file defining type-safe application keys
Various plugin and service files	Updated to import and use new APP_SETTINGS_APPKEY instead of APP_SETTINGS_KEY
Multiple test files	Updated to use new type-safe app keys for testing
Various constant and key definition files	Migrated string-based keys to web.AppKey objects

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

services/web/server/src/simcore_service_webserver/rest/healthcheck.py

packages/service-library/src/servicelib/aiohttp/application.py

services/web/server/src/simcore_service_webserver/projects/_projects_repository_legacy.py

services/web/server/tests/unit/isolated/notifications/test_wallet_osparc_credits.py

pcrespov · 2025-09-26T12:04:52Z

@mergify queue

mergify · 2025-09-26T12:04:58Z

queue

🛑 Configuration not compatible with a branch protection setting

The branch protection setting Require branches to be up to date before merging is not compatible with max_parallel_checks>1, queue_conditions != merge_conditions and must be unset.

sanderegg

thanks

sonarqubecloud · 2025-09-26T15:09:47Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

pcrespov added 2 commits September 25, 2025 18:08

final

0b0a12c

🎨 Refactor: Replace string-based app keys with type-safe web.AppKey…

c5b1ba2

… instances in various modules

pcrespov self-assigned this Sep 25, 2025

pcrespov added t:maintenance Some planned maintenance work a:webserver webserver's codebase. Assigning the area is particularly useful for bugs labels Sep 25, 2025

pcrespov added 23 commits September 25, 2025 18:46

web states

7674e6b

web states

577436a

HEALTHCHECK_APPKEY

2d6fef3

UNIT_REGISTRY_APPKEY

97120df

kesy

0e35a74

web appkeys

6f590b4

renaming

e1c9fc7

fixes mypy and pylint

15c1442

refactor: update app key constants to use type-safe web.AppKey and re…

8f18e7f

…name for consistency

suffix APPKEY

65ed11b

cleanup

b072fcf

refactor: use Final for application keys to ensure immutability

9924fde

refactor: rabbit appkeys

0955166

refactor: monitoservice

db2553d

refactor: monitoservice

51768d1

appsettings

fa9a445

new appkey

bffb9bb

new appkey

0d1c344

fix: update LOGIN_SETTINGS_PER_PRODUCT_APPKEY to use web.AppKey

502f6bc

rename with verb prefix

36c6e5c

wallet subscriptions

2db45bf

fixes tests

5f55cbc

pcrespov changed the title ~~Mai/more app keys~~ ♻️ Refactor: migrate more aiohttp app keys to type-safe web.AppKey Sep 26, 2025

pcrespov marked this pull request as ready for review September 26, 2025 08:33

pcrespov requested review from GitHK, matusdrobuliak66 and sanderegg as code owners September 26, 2025 08:33

pcrespov requested review from bisgaard-itis, Copilot, giancarloromeo and wvangeit September 26, 2025 08:33

Copilot AI reviewed Sep 26, 2025

View reviewed changes

giancarloromeo approved these changes Sep 26, 2025

View reviewed changes

GitHK approved these changes Sep 26, 2025

View reviewed changes

services/web/server/tests/unit/isolated/notifications/test_wallet_osparc_credits.py Show resolved Hide resolved

pcrespov enabled auto-merge (squash) September 26, 2025 09:57

pcrespov added this to the Cheops milestone Sep 26, 2025

pcrespov added the 🤖-automerge marks PR as ready to be merged for Mergify label Sep 26, 2025

sanderegg approved these changes Sep 26, 2025

View reviewed changes

matusdrobuliak66 approved these changes Sep 26, 2025

View reviewed changes

pcrespov added 3 commits September 26, 2025 17:01

Merge branch 'master' into mai/more-app-keys

7676ad1

fixes merge

5de886d

minor

2d612cb

pcrespov merged commit 58f9862 into ITISFoundation:master Sep 26, 2025
145 of 148 checks passed

pcrespov deleted the mai/more-app-keys branch September 29, 2025 07:12

This was referenced Oct 28, 2025

🚀 Pre-release master -> staging_Imparable1 #8430

Closed

🚀 Release v1.87.0 #8432

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

♻️ Refactor: migrate more aiohttp app keys to type-safe web.AppKey #8424

♻️ Refactor: migrate more aiohttp app keys to type-safe web.AppKey #8424

Uh oh!

pcrespov commented Sep 25, 2025 •

edited

Loading

Uh oh!

codecov bot commented Sep 25, 2025 •

edited

Loading

Uh oh!

mergify bot commented Sep 25, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pcrespov commented Sep 26, 2025

Uh oh!

mergify bot commented Sep 26, 2025 •

edited

Loading

Uh oh!

sanderegg left a comment

Uh oh!

sonarqubecloud bot commented Sep 26, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

♻️ Refactor: migrate more aiohttp app keys to type-safe web.AppKey #8424

♻️ Refactor: migrate more aiohttp app keys to type-safe web.AppKey #8424

Uh oh!

Conversation

pcrespov commented Sep 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What do these changes do?

Changes

Additions

Related issue/s

How to test

Dev-ops

Uh oh!

codecov bot commented Sep 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

mergify bot commented Sep 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🧪 CI Insights

✅ Passed Jobs With Interesting Signals

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pcrespov commented Sep 26, 2025

Uh oh!

mergify bot commented Sep 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🛑 Configuration not compatible with a branch protection setting

Uh oh!

sanderegg left a comment

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud bot commented Sep 26, 2025

Quality Gate passed

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

pcrespov commented Sep 25, 2025 •

edited

Loading

codecov bot commented Sep 25, 2025 •

edited

Loading

mergify bot commented Sep 25, 2025 •

edited

Loading

mergify bot commented Sep 26, 2025 •

edited

Loading